home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 2 / AACD 2.iso / AACD / Programming / fpc / amigaunits / amigaguide.pas < prev    next >
Pascal/Delphi Source File  |  1998-09-22  |  14KB  |  467 lines
  1. {
  2.     This file is part of the Free Pascal run time library.
  3.  
  4.     A file in Amiga system run time library.
  5.     Copyright (c) 1998 by Nils Sjoholm
  6.     member of the Amiga RTL development team.
  7.  
  8.     See the file COPYING.FPC, included in this distribution,
  9.     for details about the copyright.
  10.  
  11.     This program is distributed in the hope that it will be useful,
  12.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  14.  
  15.  **********************************************************************}
  16.  
  17.  
  18. unit amigaguide;
  19.  
  20. INTERFACE
  21.  
  22. uses exec,amigados, intuition, utility;
  23.  
  24. const
  25.  APSH_TOOL_ID           = 11000;
  26.  StartupMsgID           = (APSH_TOOL_ID+1) ;      { Startup message }
  27.  LoginToolID            = (APSH_TOOL_ID+2) ;      { Login a tool SIPC port }
  28.  LogoutToolID           = (APSH_TOOL_ID+3) ;      { Logout a tool SIPC port }
  29.  ShutdownMsgID          = (APSH_TOOL_ID+4) ;      { Shutdown message }
  30.  ActivateToolID         = (APSH_TOOL_ID+5) ;      { Activate tool }
  31.  DeactivateToolID       = (APSH_TOOL_ID+6) ;      { Deactivate tool }
  32.  ActiveToolID           = (APSH_TOOL_ID+7) ;      { Tool Active }
  33.  InactiveToolID         = (APSH_TOOL_ID+8) ;      { Tool Inactive }
  34.  ToolStatusID           = (APSH_TOOL_ID+9) ;      { Status message }
  35.  ToolCmdID              = (APSH_TOOL_ID+10);      { Tool command message }
  36.  ToolCmdReplyID         = (APSH_TOOL_ID+11);      { Reply to tool command }
  37.  ShutdownToolID         = (APSH_TOOL_ID+12);      { Shutdown tool }
  38.  
  39. { Attributes accepted by GetAmigaGuideAttr() }
  40.  AGA_Dummy              = (TAG_USER)   ;
  41.  AGA_Path               = (AGA_Dummy+1);
  42.  AGA_XRefList           = (AGA_Dummy+2);
  43.  AGA_Activate           = (AGA_Dummy+3);
  44.  AGA_Context            = (AGA_Dummy+4);
  45.  
  46.  AGA_HelpGroup          = (AGA_Dummy+5);
  47.     { (ULONG) Unique identifier }
  48.  
  49.  AGA_Reserved1          = (AGA_Dummy+6);
  50.  AGA_Reserved2          = (AGA_Dummy+7);
  51.  AGA_Reserved3          = (AGA_Dummy+8);
  52.  
  53.  AGA_ARexxPort          = (AGA_Dummy+9);
  54.     { (struct MsgPort *) Pointer to the ARexx message port (V40) }
  55.  
  56.  AGA_ARexxPortName      = (AGA_Dummy+10);
  57.    { (STRPTR) Used to specify the ARexx port name (V40) (not copied) }
  58.  
  59. Type
  60.     AMIGAGUIDECONTEXT = Pointer;
  61.  
  62.  pAmigaGuideMsg = ^tAmigaGuideMsg;
  63.  tAmigaGuideMsg = record
  64.     agm_Msg     : tMessage;                     { Embedded Exec message structure }
  65.     agm_Type    : ULONG;                        { Type of message }
  66.     agm_Data    : Pointer;                      { Pointer to message data }
  67.     agm_DSize,                                  { Size of message data }
  68.     agm_DType,                                  { Type of message data }
  69.     agm_Pri_Ret,                                { Primary return value }
  70.     agm_Sec_Ret : ULONG;                        { Secondary return value }
  71.     agm_System1,
  72.     agm_System2 : Pointer;
  73.  end;
  74.  
  75. { Allocation description structure }
  76.   pNewAmigaGuide = ^tNewAmigaGuide;
  77.   tNewAmigaGuide = record
  78.     nag_Lock  : BPTR;                           { Lock on the document directory }
  79.     nag_Name  : STRPTR;                         { Name of document file }
  80.     nag_Screen : pScreen;                       { Screen to place windows within }
  81.     nag_PubScreen,                              { Public screen name to open on }
  82.     nag_HostPort,                               { Application's ARexx port name }
  83.     nag_ClientPort,                             { Name to assign to the clients ARexx port }
  84.     nag_BaseName  : STRPTR;                     { Base name of the application }
  85.     nag_Flags  : ULONG;                         { Flags }
  86.     nag_Context: Pointer;                       { NULL terminated context table }
  87.     nag_Node   : STRPTR;                        { Node to align on first (defaults to Main) }
  88.     nag_Line   : Longint;                       { Line to align on }
  89.     nag_Extens : pTagItem;                      { Tag array extension }
  90.     nag_Client : Pointer;                       { Private! MUST be NULL }
  91.   END;
  92.  
  93. CONST
  94. { public Client flags }
  95.     HTF_LOAD_INDEX = 0;                 { Force load the index at init time }
  96.     HTF_LOAD_ALL   = 2;                 { Force load the entire database at init }
  97.     HTF_CACHE_NODE = 3;                 { Cache each node as visited }
  98.     HTF_CACHE_DB   = 8;                 { Keep the buffers around UNTIL expunge }
  99.     HTF_UNIQUE     = 32768;             { Unique ARexx port name }
  100.     HTF_NOACTIVATE = 65536;             { Don't activate window }
  101.  
  102.     HTFC_SYSGADS   = $80000000;
  103.  
  104. { Callback function ID's }
  105.     HTH_OPEN       = 0;
  106.     HTH_CLOSE      = 1;
  107.  
  108.     HTERR_NOT_ENOUGH_MEMORY       =  100;
  109.     HTERR_CANT_OPEN_DATABASE      =  101;
  110.     HTERR_CANT_FIND_NODE          =  102;
  111.     HTERR_CANT_OPEN_NODE          =  103;
  112.     HTERR_CANT_OPEN_WINDOW        =  104;
  113.     HTERR_INVALID_COMMAND         =  105;
  114.     HTERR_CANT_COMPLETE           =  106;
  115.     HTERR_PORT_CLOSED             =  107;
  116.     HTERR_CANT_CREATE_PORT        =  108;
  117.     HTERR_KEYWORD_NOT_FOUND       =  113;
  118.  
  119. Type
  120. { Cross reference node }
  121.   pXRef = ^tXRef;
  122.   tXRef = record
  123.     xr_Node   : tNode;            { Embedded node }
  124.     xr_Pad    : WORD;             { Padding }
  125.     xr_DF     : Pointer;          { Document defined in }
  126.     xr_File,                      { Name of document file }
  127.     xr_Name   : STRPTR;           { Name of item }
  128.     xr_Line   : Longint;          { Line defined at }
  129.    END;
  130.  
  131. CONST
  132. { Types of cross reference nodes }
  133.     XR_GENERIC     = 0;
  134.     XR_FUNCTION    = 1;
  135.     XR_COMMAND     = 2;
  136.     XR_INCLUDE     = 3;
  137.     XR_MACRO       = 4;
  138.     XR_STRUCT      = 5;
  139.     XR_FIELD       = 6;
  140.     XR_TYPEDEF     = 7;
  141.     XR_DEFINE      = 8;
  142.  
  143. Type
  144. { Callback handle }
  145.    pAmigaGuideHost = ^tAmigaGuideHost;
  146.    tAmigaGuideHost = record
  147.     agh_Dispatcher  : tHook;         { Dispatcher }
  148.     agh_Reserved,                 { Must be 0 }
  149.     agh_Flags,
  150.     agh_UseCnt      : ULONG;                   { Number of open nodes }
  151.     agh_SystemData,                        { Reserved for system use }
  152.     agh_UserData    : Pointer;                  { Anything you want... }
  153.    END;
  154.  
  155. CONST
  156. { Methods }
  157.     HM_FindNode    = 1 ;
  158.     HM_OpenNode    = 2 ;
  159.     HM_CloseNode   = 3 ;
  160.     HM_Expunge     = 10;              { Expunge DataBase }
  161.  
  162. Type
  163. { HM_FindNode }
  164.    popFindHost = ^topFindHost;
  165.    topFindHost = record
  166.     MethodID  : ULONG;
  167.     ofh_Attrs : pTagItem;           {  R: Additional attributes }
  168.     ofh_Node,                    {  R: Name of node }
  169.     ofh_TOC,                     {  W: Table of Contents }
  170.     ofh_Title,                   {  W: Title to give to the node }
  171.     ofh_Next,                    {  W: Next node to browse to }
  172.     ofh_Prev  : STRPTR;          {  W: Previous node to browse to }
  173.    END;
  174.  
  175. { HM_OpenNode, HM_CloseNode }
  176.    popNodeIO = ^topNodeIO;
  177.    topNodeIO = record
  178.     MethodID  : ULONG;
  179.     onm_Attrs : pTagItem;          {  R: Additional attributes }
  180.     onm_Node,                    {  R: Node name AND arguments }
  181.     onm_FileName,                {  W: File name buffer }
  182.     onm_DocBuffer : STRPTR;               {  W: Node buffer }
  183.     onm_BuffLen : ULONG;                  {  W: Size of buffer }
  184.     onm_Flags : ULONG;                    { RW: Control flags }
  185.    END;
  186.  
  187. CONST
  188. { onm_Flags }
  189.     HTNF_KEEP      = 0; { Don't flush this node UNTIL database is
  190.                                  * closed. }
  191.     HTNF_Reserved1 = 2 ; { Reserved for system use }
  192.     HTNF_Reserved2 = 4 ; { Reserved for system use }
  193.     HTNF_ASCII     = 8 ; { Node is straight ASCII }
  194.     HTNF_Reserved3 = 16; { Reserved for system use }
  195.     HTNF_CLEAN     = 32; { Remove the node from the database }
  196.     HTNF_DONE      = 64; { Done with node }
  197.  
  198. { onm_Attrs }
  199.     HTNA_Dummy     = TAG_USER;
  200.     HTNA_Screen    = (TAG_USER + 1);  { Screen that window resides in }
  201.     HTNA_Pens      = (TAG_USER + 2);  { Pen array (from DrawInfo) }
  202.     HTNA_Rectangle = (TAG_USER + 3);  { Window box }
  203.  
  204.     HTNA_HelpGroup = (HTNA_Dummy+5);  { (ULONG) unique identifier }
  205.  
  206.  
  207. Type
  208. { HM_Expunge }
  209.   popExpungeNode = ^topExpungeNode;
  210.   topExpungeNode = record
  211.     MethodID  : ULONG;
  212.     oen_Attrs : pTagItem;          {  R: Additional attributes }
  213.   END;
  214.  
  215. VAR AmigaGuideBase : pLibrary;
  216.  
  217. FUNCTION AddAmigaGuideHostA(h : pHook; name : pCHAR; attrs : pTagItem) : POINTER;
  218. FUNCTION AmigaGuideSignal(cl : POINTER) : ULONG;
  219. PROCEDURE CloseAmigaGuide(cl : POINTER);
  220. PROCEDURE ExpungeXRef;
  221. FUNCTION GetAmigaGuideAttr(tag : ULONG; cl : POINTER; storage : POINTER) : LONGINT;
  222. FUNCTION GetAmigaGuideMsg(cl : POINTER) : pAmigaGuideMsg;
  223. FUNCTION GetAmigaGuideString(id : LONGINT) : pCHAR;
  224. FUNCTION LoadXRef(lock : LONGINT; name : pCHAR) : LONGINT;
  225. FUNCTION LockAmigaGuideBase(handle : POINTER) : LONGINT;
  226. FUNCTION OpenAmigaGuideA(nag : pNewAmigaGuide; taglist : pTagItem) : POINTER;
  227. FUNCTION OpenAmigaGuideAsyncA(nag : pNewAmigaGuide; attrs : pTagItem) : POINTER;
  228. FUNCTION RemoveAmigaGuideHostA(hh : POINTER; attrs : pTagItem) : LONGINT;
  229. PROCEDURE ReplyAmigaGuideMsg(amsg : pAmigaGuideMsg);
  230. FUNCTION SendAmigaGuideCmdA(cl : POINTER; cmd : pCHAR; attrs : pTagItem) : LONGINT;
  231. FUNCTION SendAmigaGuideContextA(cl : POINTER; attrs : pTagItem) : LONGINT;
  232. FUNCTION SetAmigaGuideAttrsA(cl : POINTER; attrs : pTagItem) : LONGINT;
  233. FUNCTION SetAmigaGuideContextA(cl : POINTER; id : ULONG; attrs : pTagItem) : LONGINT;
  234. PROCEDURE UnlockAmigaGuideBase(key : LONGINT);
  235.  
  236. IMPLEMENTATION
  237.  
  238. FUNCTION AddAmigaGuideHostA(h : pHook; name : pCHAR; attrs : pTagItem) : POINTER;
  239. BEGIN
  240.   ASM
  241.     MOVE.L  A6,-(A7)
  242.     MOVEA.L h,A0
  243.     MOVE.L  name,D0
  244.     MOVEA.L attrs,A1
  245.     MOVEA.L AmigaGuideBase,A6
  246.     JSR -138(A6)
  247.     MOVEA.L (A7)+,A6
  248.     MOVE.L  D0,@RESULT
  249.   END;
  250. END;
  251.  
  252. FUNCTION AmigaGuideSignal(cl : POINTER) : ULONG;
  253. BEGIN
  254.   ASM
  255.     MOVE.L  A6,-(A7)
  256.     MOVEA.L cl,A0
  257.     MOVEA.L AmigaGuideBase,A6
  258.     JSR -072(A6)
  259.     MOVEA.L (A7)+,A6
  260.     MOVE.L  D0,@RESULT
  261.   END;
  262. END;
  263.  
  264. PROCEDURE CloseAmigaGuide(cl : POINTER);
  265. BEGIN
  266.   ASM
  267.     MOVE.L  A6,-(A7)
  268.     MOVEA.L cl,A0
  269.     MOVEA.L AmigaGuideBase,A6
  270.     JSR -066(A6)
  271.     MOVEA.L (A7)+,A6
  272.   END;
  273. END;
  274.  
  275. PROCEDURE ExpungeXRef;
  276. BEGIN
  277.   ASM
  278.     MOVE.L  A6,-(A7)
  279.     MOVEA.L AmigaGuideBase,A6
  280.     JSR -132(A6)
  281.     MOVEA.L (A7)+,A6
  282.   END;
  283. END;
  284.  
  285. FUNCTION GetAmigaGuideAttr(tag : ULONG; cl : POINTER; storage : POINTER) : LONGINT;
  286. BEGIN
  287.   ASM
  288.     MOVE.L  A6,-(A7)
  289.     MOVE.L  tag,D0
  290.     MOVEA.L cl,A0
  291.     MOVEA.L storage,A1
  292.     MOVEA.L AmigaGuideBase,A6
  293.     JSR -114(A6)
  294.     MOVEA.L (A7)+,A6
  295.     MOVE.L  D0,@RESULT
  296.   END;
  297. END;
  298.  
  299. FUNCTION GetAmigaGuideMsg(cl : POINTER) : pAmigaGuideMsg;
  300. BEGIN
  301.   ASM
  302.     MOVE.L  A6,-(A7)
  303.     MOVEA.L cl,A0
  304.     MOVEA.L AmigaGuideBase,A6
  305.     JSR -078(A6)
  306.     MOVEA.L (A7)+,A6
  307.     MOVE.L  D0,@RESULT
  308.   END;
  309. END;
  310.  
  311. FUNCTION GetAmigaGuideString(id : LONGINT) : pCHAR;
  312. BEGIN
  313.   ASM
  314.     MOVE.L  A6,-(A7)
  315.     MOVE.L  id,D0
  316.     MOVEA.L AmigaGuideBase,A6
  317.     JSR -210(A6)
  318.     MOVEA.L (A7)+,A6
  319.     MOVE.L  D0,@RESULT
  320.   END;
  321. END;
  322.  
  323. FUNCTION LoadXRef(lock : LONGINT; name : pCHAR) : LONGINT;
  324. BEGIN
  325.   ASM
  326.     MOVE.L  A6,-(A7)
  327.     MOVEA.L lock,A0
  328.     MOVEA.L name,A1
  329.     MOVEA.L AmigaGuideBase,A6
  330.     JSR -126(A6)
  331.     MOVEA.L (A7)+,A6
  332.     MOVE.L  D0,@RESULT
  333.   END;
  334. END;
  335.  
  336. FUNCTION LockAmigaGuideBase(handle : POINTER) : LONGINT;
  337. BEGIN
  338.   ASM
  339.     MOVE.L  A6,-(A7)
  340.     MOVEA.L handle,A0
  341.     MOVEA.L AmigaGuideBase,A6
  342.     JSR -036(A6)
  343.     MOVEA.L (A7)+,A6
  344.     MOVE.L  D0,@RESULT
  345.   END;
  346. END;
  347.  
  348. FUNCTION OpenAmigaGuideA(nag : pNewAmigaGuide; taglist : pTagItem) : POINTER;
  349. BEGIN
  350.   ASM
  351.     MOVE.L  A6,-(A7)
  352.     MOVEA.L nag,A0
  353.     MOVEA.L taglist,A1
  354.     MOVEA.L AmigaGuideBase,A6
  355.     JSR -054(A6)
  356.     MOVEA.L (A7)+,A6
  357.     MOVE.L  D0,@RESULT
  358.   END;
  359. END;
  360.  
  361. FUNCTION OpenAmigaGuideAsyncA(nag : pNewAmigaGuide; attrs : pTagItem) : POINTER;
  362. BEGIN
  363.   ASM
  364.     MOVE.L  A6,-(A7)
  365.     MOVEA.L nag,A0
  366.     MOVE.L  attrs,D0
  367.     MOVEA.L AmigaGuideBase,A6
  368.     JSR -060(A6)
  369.     MOVEA.L (A7)+,A6
  370.     MOVE.L  D0,@RESULT
  371.   END;
  372. END;
  373.  
  374. FUNCTION RemoveAmigaGuideHostA(hh : POINTER; attrs : pTagItem) : LONGINT;
  375. BEGIN
  376.   ASM
  377.     MOVE.L  A6,-(A7)
  378.     MOVEA.L hh,A0
  379.     MOVEA.L attrs,A1
  380.     MOVEA.L AmigaGuideBase,A6
  381.     JSR -144(A6)
  382.     MOVEA.L (A7)+,A6
  383.     MOVE.L  D0,@RESULT
  384.   END;
  385. END;
  386.  
  387. PROCEDURE ReplyAmigaGuideMsg(amsg : pAmigaGuideMsg);
  388. BEGIN
  389.   ASM
  390.     MOVE.L  A6,-(A7)
  391.     MOVEA.L amsg,A0
  392.     MOVEA.L AmigaGuideBase,A6
  393.     JSR -084(A6)
  394.     MOVEA.L (A7)+,A6
  395.   END;
  396. END;
  397.  
  398. FUNCTION SendAmigaGuideCmdA(cl : POINTER; cmd : pCHAR; attrs : pTagItem) : LONGINT;
  399. BEGIN
  400.   ASM
  401.     MOVE.L  A6,-(A7)
  402.     MOVEA.L cl,A0
  403.     MOVE.L  cmd,D0
  404.     MOVE.L  attrs,D1
  405.     MOVEA.L AmigaGuideBase,A6
  406.     JSR -102(A6)
  407.     MOVEA.L (A7)+,A6
  408.     MOVE.L  D0,@RESULT
  409.   END;
  410. END;
  411.  
  412. FUNCTION SendAmigaGuideContextA(cl : POINTER; attrs : pTagItem) : LONGINT;
  413. BEGIN
  414.   ASM
  415.     MOVE.L  A6,-(A7)
  416.     MOVEA.L cl,A0
  417.     MOVE.L  attrs,D0
  418.     MOVEA.L AmigaGuideBase,A6
  419.     JSR -096(A6)
  420.     MOVEA.L (A7)+,A6
  421.     MOVE.L  D0,@RESULT
  422.   END;
  423. END;
  424.  
  425. FUNCTION SetAmigaGuideAttrsA(cl : POINTER; attrs : pTagItem) : LONGINT;
  426. BEGIN
  427.   ASM
  428.     MOVE.L  A6,-(A7)
  429.     MOVEA.L cl,A0
  430.     MOVEA.L attrs,A1
  431.     MOVEA.L AmigaGuideBase,A6
  432.     JSR -108(A6)
  433.     MOVEA.L (A7)+,A6
  434.     MOVE.L  D0,@RESULT
  435.   END;
  436. END;
  437.  
  438. FUNCTION SetAmigaGuideContextA(cl : POINTER; id : ULONG; attrs : pTagItem) : LONGINT;
  439. BEGIN
  440.   ASM
  441.     MOVE.L  A6,-(A7)
  442.     MOVEA.L cl,A0
  443.     MOVE.L  id,D0
  444.     MOVE.L  attrs,D1
  445.     MOVEA.L AmigaGuideBase,A6
  446.     JSR -090(A6)
  447.     MOVEA.L (A7)+,A6
  448.     MOVE.L  D0,@RESULT
  449.   END;
  450. END;
  451.  
  452. PROCEDURE UnlockAmigaGuideBase(key : LONGINT);
  453. BEGIN
  454.   ASM
  455.     MOVE.L  A6,-(A7)
  456.     MOVE.L  key,D0
  457.     MOVEA.L AmigaGuideBase,A6
  458.     JSR -042(A6)
  459.     MOVEA.L (A7)+,A6
  460.   END;
  461. END;
  462.  
  463. END. (* UNIT AMIGAGUIDE *)
  464.  
  465.  
  466.  
  467.